docs(api): document recoveryDisabled field on SessionInfo (#4802)#4805
Merged
Conversation
PR #4803 added a per-session kill-switch for stall auto-recovery (F-4). The new optional boolean field `recoveryDisabled?: boolean` is persisted on SessionInfo and exposed in the GET /v1/sessions/:id response. Document the field semantics for API consumers: - Operator-facing kill-switch for stall auto-recovery - Survives Aegis restarts (persisted on session record) - Only present when explicitly set (defaults to false) - Currently toggled via dashboard stall pill (PR #4804 follow-up); no REST endpoint to set it directly yet Refs: #4802 (F-4)
![aegis-gh-agent[bot]](https://avatars.githubusercontent.com/u/106186915?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
✅ Approved.
9-gate audit pass:
- ✅ Review completed — full diff read (+2/-1, 1 file)
- ✅ No conflicts — branch up-to-date with develop (MERGEABLE)
- ✅ CI green — all 17 checks passing (lint, tests ubuntu-20/22, CodeQL, GitGuardian, Gitleaks, Trivy, helm-smoke, dashboard-e2e, platform-smoke mac/win, sdk-drift, feat-minor-bump-gate, lint-pr-title)
- ✅ No regressions — docs-only change
- ✅ Unit tests — N/A (docs)
- ✅ E2E/UAT — N/A (docs)
- ✅ Documented — this IS the documentation
- ✅ Security clean — no secrets, no code
- ✅ Targets develop — base=develop ✅
Substance LGTM. Documents the recoveryDisabled?: boolean field on GET /v1/sessions/:id response, introduced in PR #4803 (server-side F-4 per-session kill-switch, merged 2026-06-22T12:33:33Z).
Cross-references in PR body are accurate:
- Issue #4802 (F-4 spec) ✅
- PR #4803 (server impl) — MERGED ✅
- PR #4804 (dashboard stall pill follow-up) — in flight, gated on
approved-minor-bumplabel
Field semantics in the table are precise: optional (defaults to false), persists across restarts, dashboard-only toggle (no REST endpoint), matches the server-side recoveryDisabled?: boolean shape from PR #4803. Description wording is consistent with the rest of the api-reference.md table format.
Squash-merging to develop via bot API.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new optional
recoveryDisabled?: booleanfield on theGET /v1/sessions/:idresponse, introduced in PR #4803 (Issue #4802 F-4).What changed
docs/api-reference.md: addedrecoveryDisabledto the response field table forGET /v1/sessions/:idwith semantics (per-session stall auto-recovery kill-switch, persists across restarts, currently dashboard-only toggle).Why
PR #4803 ship the F-4 per-session kill-switch as an additive SessionInfo field. API consumers polling
GET /v1/sessions/:idwill see this field appear when an operator pauses auto-recovery on a session. Without docs, the field is opaque — operators reading the API response can't tell why a stalled session stopped auto-recovering.Aegis version
Developed with: v0.6.7
Cross-references
Verification
npm run hygiene-check— passednpm run security-check— passednpm run token-check— passednpm run audit-check— passednpm run gate:arch— passed (no changed TS files)npm run lint— 0 errors (pre-existing warnings only)npx tsc --noEmit— passednpm run dashboard:tokens:gate— passednpm run dashboard:clickable:gate— passedDiff: 1 file, +2/-1 (3 lines).